Document Elasticsearch v9 support and v7.17 deprecation#8849
Open
lieut-data wants to merge 3 commits intomasterfrom
Open
Document Elasticsearch v9 support and v7.17 deprecation#8849lieut-data wants to merge 3 commits intomasterfrom
lieut-data wants to merge 3 commits intomasterfrom
Conversation
Add Elasticsearch v9 as a supported search backend starting from Mattermost v11.7, note that v7.17 is no longer supported, and update version references across setup and requirements documentation.
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA d71578b |
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA 9ecfc75 |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughUpdated documentation to recognize Elasticsearch v9 as supported/current, adjust references to Elasticsearch v8 (now 8.19), remove v7.17 support as of Mattermost v11.7, and make the ChangesElasticsearch Version Support Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@source/administration-guide/scale/elasticsearch-setup.rst`:
- Line 46: Update the sentence that advises setting
action.destructive_requires_name to false in elasticsearch.yml to include an
explicit safety note: warn that this setting defaults to true in ES 8/9 and
disabling it permits dangerous wildcard deletes (e.g., DELETE * or DELETE .*)
that can remove system indices used for authentication; state when this
temporary change is required (only for the specific maintenance step described),
require restoring action.destructive_requires_name to true immediately after the
operation, and suggest the safer wildcard exclusion pattern "*,-.*" (exclude
system indices) as an alternative to turning the protection off.
In `@source/deployment-guide/software-hardware-requirements.rst`:
- Line 235: Update the sentence that currently reads "Elasticsearch v8.x and
v9.x are supported, and Elasticsearch v9.x or AWS OpenSearch is recommended" to
qualify v9 support by adding that Elasticsearch v9.x is supported beginning with
Mattermost v11.7 (e.g., "Elasticsearch v8.x is supported; Elasticsearch v9.x is
supported beginning with Mattermost v11.7, and Elasticsearch v9.x or AWS
OpenSearch is recommended"). Keep the existing :doc:`Learn more
</administration-guide/scale/enterprise-search>` link and adjust punctuation as
needed so the sentence remains grammatically correct.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: bb6b22b8-9355-48f2-9a3a-15003c1c0e3e
📒 Files selected for processing (3)
source/administration-guide/scale/elasticsearch-setup.rstsource/administration-guide/scale/enterprise-search.rstsource/deployment-guide/software-hardware-requirements.rst
esethna
added
the
Do Not Merge/Awaiting Next Release
Contributor
|
Adding the do not merge label so this can be rebased to the 11.7 branch when it's cut |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates Mattermost enterprise search documentation to reflect Elasticsearch v9 support (starting Mattermost v11.7) and the deprecation of Elasticsearch v7.17, with refreshed version references/links across related docs.
Changes:
- Added an Elasticsearch v9 support path (Mattermost v11.7+) and clarified v7.17 deprecation.
- Updated software/hardware requirements to reflect supported/recommended Elasticsearch versions.
- Updated Elasticsearch setup instructions and Elastic documentation links to newer versions.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| source/deployment-guide/software-hardware-requirements.rst | Updates supported/recommended Elasticsearch versions in requirements list. |
| source/administration-guide/scale/enterprise-search.rst | Adds v9 tab, adds v7.17 deprecation note, and updates versioned links/text. |
| source/administration-guide/scale/elasticsearch-setup.rst | Updates setup steps to reference v9/v8 and adjusts guidance text. |
| - Prometheus to track system health of your Mattermost deployment, through :doc:`performance monitoring feature </administration-guide/scale/deploy-prometheus-grafana-for-performance-monitoring>` available in Mattermost Enterprise. | ||
| - Grafana to visualize the system health metrics collected by Prometheus with the :doc:`performance monitoring feature </administration-guide/scale/deploy-prometheus-grafana-for-performance-monitoring>`. Grafana 5.0.0 and later is recommended. | ||
| - Elasticsearch to support highly efficient database searches in a cluster environment. Elasticsearch v7.17+ is supported, and Elasticsearch v8.x or AWS OpenSearch is recommended from Mattermost v9.11. :doc:`Learn more </administration-guide/scale/enterprise-search>`. | ||
| - Elasticsearch to support highly efficient database searches in a cluster environment. Elasticsearch v8.x and v9.x are supported, and Elasticsearch v9.x or AWS OpenSearch is recommended. :doc:`Learn more </administration-guide/scale/enterprise-search>`. |
|
|
||
| .. tab:: Elasticsearch v9 | ||
|
|
||
| `Elasticsearch v9 <https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html>`__ is supported from Mattermost v11.7. We recommend upgrading to Elasticsearch v9 for the latest features and security updates. See the `Elasticsearch upgrade <https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html>`_ documentation for upgrade details, and see the :doc:`Elasticsearch setup </administration-guide/scale/elasticsearch-setup>` documentation for details on configuring your Mattermost deployment to use Elasticsearch. |
| We highly recommend that you set up Elasticsearch server on a dedicated machine separate from the Mattermost Server. | ||
|
|
||
| 1. Download and install the latest release of `Elasticsearch v8 <https://www.elastic.co/guide/en/elasticsearch/reference/8.15/install-elasticsearch.html>`_, or `Elasticsearch v7.17+ <https://www.elastic.co/guide/en/elasticsearch/reference/7.17/install-elasticsearch.html>`_. See the Elasticsearch documentation for installation details. | ||
| 1. Download and install the latest release of `Elasticsearch v9 <https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html>`_ or `Elasticsearch v8 <https://www.elastic.co/guide/en/elasticsearch/reference/8.19/install-elasticsearch.html>`_. See the Elasticsearch documentation for installation details. |
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA 0b16290 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan